Modul REST Abfrage

Mit dem Modul REST Abfrage (REpresentational State Transfer) können aus den per REST angeforderten Daten mehrere Variablen gefüllt werden, die im weiteren Verlauf des Workflows (z.B im Modul Entscheidung) oder auch in einer Metadatei verwendet werden können.

Das Modul kann mehrfach im Workflow vorkommen.

Modul Interview Eingabe

Modul Interview Auswahl

Modul Zonen OCR, Barcode, QRCode

Das Modul kann mit allen Modulen verbunden werden (es können sich dadurch unsinnige Workflows ergeben).

Keine einschränkenden Module.

Erfolgreich: Hier folgt das Modul, das nach erfolgreicher Eingabe bzw. Auswahl ausgeführt werden soll.

Abbrechen: Hier folgt das Modul, das ausgeführt werden soll, wenn der Anwender das Interview aktiv durch Druck auf die Abbrechen-Schaltfläche beendet hat.

Time-out: Hier folgt das Modul, das ausgeführt werden soll, wenn nach dem in den Moduleinstellungen festgelegten Time-out-Zeitraum die Eingabe nicht abgeschlossen ist.

Die Einstellungen hängen sehr stark von der Art der REST-Schnittstelle ab. Besonders die Verbindungseinstellungen sind sehr individuell.

Geben Sie hier den Text an, der über der Auswahlliste angezeigt werden soll (z.B. Wählen Sie einen Dokumententyp.)

Hier können Sie einen Zeitraum in Minuten festlegen, nach dem das Modul mit dem Ausgang Time-out fortgesetzt wird, wenn der Anwender im Interview keine Eingabe vornimmt. Die Zeit läuft unabhängig von Tastatureingaben, sie gilt als abgeschlossen, wenn die Schaltfläche Fortsetzen am Gerät gedrückt wird (d.h. der Anwender muss in dieser Zeit die Eingabe vollständig abgeschlossen haben).

Der Wert 0 steht für kein Time-out (die Zeit für die Eingabe am Gerät ist unbegrenzt).

Im WebClient werden Interviews im Bereich Meine Aufgaben (siehe Meine Aufgaben) angezeigt. Um diesen Bereich sehen zu können, ist die Anwenderlizenz Dokumenten-Prüfung erforderlich.

Das Interview wird am Gerät angezeigt und kann dort beantwortet werden.

Mit den Verbindungseinstellungen wird die Verbindung zur externen API (Schnittstelle, Application Programming Interface) hergestellt. Diese sind stark von der API abhängig. Grundsätzlich wird die REST-Schnittstelle mit den Verbindungsdaten abgefragt und es kommt ein JToken zurück (als Objekt oder Array).

  • Verbindung: Wählen Sie aus der Klappliste die gewünschte Verbindung aus. Ist noch keine Verbindung vorhanden, klicken Sie auf Verbindung erstellen, siehe auch API Verbindungen.

  • Ressource: Eine Ressource kann jedes Objekt sein, über das die API Informationen bereitstellt oder entgegennimmt, z.B. restinformation/user. (Kein / am Anfang der Ressource setzen.) Die Ressource wird bei der Abfrage an die Basis URL, die bei der Verbindung angegeben wird, angehangen.

Mit Verbindung prüfen können Sie die Verbindungsdaten testen. Es wird das JSON-Objekt der Schnittstelle zurückgeliefert.

Es können aus den Daten mehrere Variablen in einem Zug gefüllt werden. Fügen Sie Variablen über Variable hinzufügen hinzu oder entfernen Sie Variablen mit dem Löschsymbol .

  • Variablenname: Name der Variable, z.B. Name.

  • Datenmaske: Geben Sie hier die Datenmaske ein, die den gewünschten Wert aus dem Filterergebnis ausgibt, z.B. {{displayName}}.

Variablennamen dürfen keine Sonderzeichen enthalten. Erlaubt sind kleine und große Buchstaben (keine Umlaute o.Ä.), Zahlen und der Punkt ".".
Wird der Variablenname an mehreren Stellen verwendet, können alle Stellen den Variablenwert beeinflussen.

Hier können Sie einen Zeitraum in Minuten festlegen, nach dem das Modul mit dem Ausgang Time-out fortgesetzt wird, wenn der Anwender im Interview keine Eingabe vornimmt. Die Zeit läuft unabhängig von Tastatureingaben, sie gilt als abgeschlossen, wenn die Schaltfläche Fortsetzen am Gerät gedrückt wird (d.h. der Anwender muss in dieser Zeit die Eingabe vollständig abgeschlossen haben).

Der Wert 0 steht für kein Time-out (die Zeit für die Eingabe am Gerät ist unbegrenzt).

Geben Sie hier den treiberspezifischen Verbindungsstring an. Geben Sie ihn in einer Zeile ohne Zeilentrennung an. Beispiel: 

  • Driver={SQL Server Native Client 11.0};Server=myServerAddress;Database=myDataBase;Uid=myUsername;Pwd=myPassword;

Der Syntax des SQL-Statements hängt ebenfalls stark vom verwendeten Verbindungsstring ab. Geben Sie Variablen in der gewohnten Notation %Variablenname% an.

Die ersten beiden Felder der Ergebnisliste werden verwendet. Das erste Feld wird als Variablenwert verwendet, das zweite Feld als angezeigter Text. Hat die Ergebnisliste nur ein Feld, wird dieser als angezeigter Text und Variablenwert verwendet.

Beispiele:

  • select ID, Name from Auswahltabelle where login='%username%'

  • select Name from Auswahltabelle

  • select * from Auswahltabelle

Sie können die ODBC-Verbindung prüfen, indem Sie ein gültiges SQL-Statement verwenden und für verwendete Variablen tatsächliche Werte angeben. Sie erhalten die Ergebnisse mit | getrennt (gibt es nur ein Ergebnis wird der Wert mit folgendem | Zeichen ausgegeben). Beispiel:

  • select Name from Tabelle where Nr='005'

Der WorkflowService kennt alle Informationen rund um einen (im Workflow-Editior erstellten) Workflow. Er sorgt dafür, dass der Ablauf eingehalten wird und leitet Informationen an im Workflow folgende Module bzw. deren Dienste weiter. Seine Logdatei ist Logs\WorkflowService.log.